/*
 * Copyright (c) 2025 Huawei Device Co., Ltd.
 * Licensed under the Apache License, Version 2.0 (the "License"),
 * you may not use this file except in compliance with the License.
 * You may obtain a copy of the License at
 *
 *     http://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS,
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 * See the License for the specific language governing permissions and
 * limitations under the License.
 */

/**
 * @addtogroup TeeTrusted
 * @{
 *
 * @brief TEE（Trusted Excution Environment）可信执行环境API。
 *
 * 提供安全能力API，例如可信存储、加解密及可信时间等，用于可信应用程序开发。
 *
 * @since 20
 */

/**
 * @file tee_agent.h
 *
 * @brief 提供TA代理相关的API。
 *
 * @library NA
 * @kit TEEKit
 * @include <TEEKit/tee_agent.h>
 * @syscap SystemCapability.Tee.TeeClient
 * @since 20
 */

#ifndef TEE_AGENT_H
#define TEE_AGENT_H

#include <stdint.h>
#include <tee_defines.h>

#ifdef __cplusplus
extern "C" {
#endif

/**
 * @brief TA发送消息给gtask以锁定代理。
 *
 * @param agent_id 请求被锁定的代理ID。
 *
 * @return TEE_SUCCESS：操作成功。\n
 *         否则返回其他信息。
 * @since 20
 */
TEE_Result tee_agent_lock(uint32_t agent_id);

/**
 * @brief 解锁代理。
 *
 * @param agent_id 请求被解锁的代理ID。
 *
 * @return TEE_SUCCESS：操作成功。\n
 *         否则返回其他信息。
 * @since 20
 */
TEE_Result tee_agent_unlock(uint32_t agent_id);

/**
 * @brief 发送代理命令给gtask。
 *
 * @param agent_id 代理ID。
 *
 * @return TEE_SUCCESS：操作成功。\n
 *         否则返回其他信息。
 * @since 20
 */
TEE_Result tee_send_agent_cmd(uint32_t agent_id);

/**
 * @brief 在获取代理缓冲区接收消息。
 *
 * @param agent_id 代理ID。
 * @param buffer 代理缓冲区。
 * @param length 代理缓冲区的长度。
 *
 * @return TEE_SUCCESS：操作成功。\n
 *         否则返回其他信息。
 * @since 20
 */
TEE_Result tee_get_agent_buffer(uint32_t agent_id, void **buffer, uint32_t *length);

#ifdef __cplusplus
}
#endif

#endif
/** @} */